home *** CD-ROM | disk | FTP | other *** search
/ Dr. Windows 3 / dr win3.zip / dr win3 / VISUALBA / DFVB10.ZIP / DFRAMEVB.DOC < prev    next >
Text File  |  1993-01-06  |  61KB  |  1,162 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.                                D O O R F R A M E
  17.                                   Version 1.0
  18.  
  19.                         A BBS Doors Development Library
  20.                        for the Visual Basic DOS compiler
  21.  
  22.                               Copyright (c) 1992
  23.                                 by Ted Freeman
  24.                              All rights reserved.
  25.  
  26.  
  27.                                Support board is:
  28.  
  29.                                MicroNet PCBoard
  30.                            Node1: 615-626-1620 ULTRA
  31.  
  32.  
  33.  
  34. DOORFRAME v1.0 - Users Guide - Page i
  35.  
  36.  
  37.                                 C O N T E N T S
  38.                                =================
  39.  
  40.         Warranty ............................................ ii
  41.         Copyright notice .................................... ii
  42.         Distribution ........................................ ii
  43.         Description ......................................... ii
  44.         BOX.IT .............................................. 1
  45.         BACK.SPACE .......................................... 2
  46.         CLREOL .............................................. 2
  47.         CLRMOL .............................................. 2
  48.         CLRSOL .............................................. 2
  49.         CLRSCRN ............................................. 2
  50.         DE.LAY .............................................. 2
  51.         DETECT.ANSI ......................................... 2
  52.         DIS.PLAY ............................................ 3
  53.         ENTER ............................................... 4
  54.         EXIT.DOOR ........................................... 4
  55.         IN.PUT .............................................. 4
  56.         INITIALIZE .......................................... 5
  57.         LINES ............................................... 5
  58.         MAKE.BLT ............................................ 6
  59.         MAKE.BLT.CURRENT .................................... 6
  60.         MORE ................................................ 6
  61.         MUSIC ............................................... 6
  62.         OUT.PUT ............................................. 6
  63.         SEND ................................................ 7
  64.         SHOW.BLT ............................................ 7
  65.         COLOR TABLE ......................................... 8
  66.         CONFIGURATION FILE FORMAT ........................... 9
  67.         PCBOARD.SYS VARIABLES ............................... 10
  68.         USERS.SYS VARIABLES ................................. 12
  69.         DOOR.SYS VARIABLES .................................. 13
  70.         USERINFO.DAT VARIABLES .............................. 15
  71.         DORINFOx.DEF VARIABLES .............................. 15
  72.         CALLINFO.BBS VARIABLES .............................. 16
  73.         SFDOORS.DAT VARIABLES ............................... 18
  74.         CHAIN.TXT VARIABLES ................................. 20
  75.         MISCELLANEOUS NOTES ................................. 21
  76.  
  77.  
  78. DOORFRAME v1.0 - Users Guide - Page ii
  79.  
  80.  
  81.                                    Warranty
  82.  
  83.     This product is provided "as is" without warranty of any kind. The entire
  84.     risk as to the results and  performance of the program is assumed by you.
  85.     Futhermore, the  author does  not warrant, guarantee, or  make any  other
  86.     representations regarding  the use of,  or the  results of the use of the
  87.     program,  and you  rely on the  program and  results  solely at  your own
  88.     risk.  The author  cannot and  will not accept  responsibility for system
  89.     damage, loss of profit, or any other special, consequential or incidental 
  90.     damages  resulting  from  the  use  or  inability  to  use this  product.
  91.  
  92.                                    Copyright
  93.  
  94.     DOORFRAME Copyright (c) 1990-92 by  Ted Freeman  is being distributed as
  95.     Shareware. Under this concept you may use the  SHAREWARE  (unregistered)
  96.     version for a reasonable period of  time for evaluation  after which you
  97.     must either register your copy or discontinue  usage.
  98.  
  99.  
  100.                                  Distribution
  101.  
  102.     You  are encouraged to distribute DOORFRAME provided that all files
  103.     contained in the archive are distributed in their original and
  104.     unmodified state.
  105.  
  106.                                   Description
  107.     
  108.     DOORFRAME is a subroutine library for developing online BBS Doors for
  109.     systems that are compatible with PCBOARD.SYS, USERS.SYS, DOOR.SYS,
  110.     CALLINFO.BBS, USERINFO.DAT, SFDOORS.DAT, CHAIN.TXT, or DORINFOx.DEF for
  111.     interfacing to the BBS.
  112.     This version of DoorFrame was written for BASCOM (tm) 7.x and is not
  113.     recommended for use with earlier versions of the compiler. DoorFrame also
  114.     utilizes some of the routines contained in Tom Hanlin's PBClone library.
  115.     The COM routines are handled by the QBSerial I/O library.
  116.     NOTE: A version of DoorFrame is also available for Quickbasic 4.x.
  117.  
  118.  
  119. DOORFRAME v1.0 - Users Guide - Page 1
  120.  
  121.  
  122.                               DOORFRAME ROUTINES
  123.                              ====================
  124.  
  125. NOTE: 
  126. Since the subroutines are DECLAREd in DFRAMEX.INC (you DID $INCLUDE: it didn't 
  127. you?) you should not use the CALL statement. Type the name of the subroutine 
  128. and list it's parameters (if any) without the enclosing parentheses.
  129. For example:
  130.  
  131.  DIS.PLAY MSG$, FG%, BG%, BLINK%, BELL%, XPOS%, YPOS%, NL%, CENTER%, CAPS% 
  132. ------------------------------------------------------------------------------
  133.  
  134. SUBROUTINE: 
  135. BOX.IT SROW%,SCOL%,EROW%,ECOL%,BTYPE%,BFG%,BBG%,FFG%,FBG%,FCHAR%,SHADOW%,TITLE$,HFG%,HBG%
  136. PARAMETERS: SROW%    - ROW the box is to start at. Valid numbers are 1 - 22.
  137.                        Accepts an INTEGER number or variable.
  138.             SCOL%    - COLUMN the box is to start at. Valid numbers are 1 - 79.
  139.                        Accepts an INTEGER number or variable.
  140.             EROW%    - ROW the box is to end at. Valid numbers are 2 - 23.
  141.                        Accepts an INTEGER number or variable.
  142.             ECOL%    - COLUMN the box is to end at. Valid numbers are 2 - 80.
  143.                        Accepts an INTEGER number or variable.
  144.             BTYPE%   - Type of border. Accepts an INTEGER number or variable.
  145.                          0 = No border (spaces all the way around).
  146.                          1 = Single line all the way around.
  147.                          2 = Double line all the way around.
  148.                          3 = Double line on sides, single on top and bottom.
  149.                          4 = Single line on sides, double on top and bottom.
  150.             BFG%     - Foreground color of the border. (See color table)
  151.                        Accepts an INTEGER number or variable.
  152.             BBG%     - Background color of the border. (See color table)
  153.                        Accepts an INTEGER number or variable.
  154.             FFG%     - Foreground color of the box fill characters.
  155.                        Accepts an INTEGER number or variable.
  156.             FBG%     - Background color of the box fill characters.
  157.                        Accepts an INTEGER number or variable.
  158.             FCHAR%   - ASCII number of the character to fill box with.
  159.                        EX: 32 = SPACE, 65 = A, 206 = ╬
  160.             SHADOW%  - 1 = Shadow, 0 = no Shadow. This will put a Shadow
  161.                        on the right and bottom edges of the box.
  162.             TITLE$   - Displays a title centered on the top border.
  163.                        Accepts a STRING variable or QUOTED TEXT.
  164.             HFG%     - Foreground color of TITLE$
  165.             HFG%     - Background color of TITLE$
  166.  
  167. DESCRIPTION: Draws a BOX with various style borders. The inside of the
  168.              BOX may be filled with any ASCII character you choose. The
  169.              upper left corner of the screen is ROW 1, COLUMN 1 and the
  170.              bottom right is ROW 23, COLUMN 80.
  171.  
  172.  
  173.  
  174.  
  175. DOORFRAME v1.0 - Users Guide - Page 2
  176.  
  177. SUBROUTINE: BACK.SPACE ROW%, COL%, NUM%
  178. PARAMETERS: ROW%, COL%, NUM%
  179. DESCRIPTION: Backspaces NUM% from the ROW% and COL% specified.
  180.  
  181. SUBROUTIN